home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / aglr152.zip / AGLREP.DOC next >
Text File  |  1991-03-25  |  12KB  |  247 lines
  1. AGLREP - Advanced GBag List Reporter      Version 1.50
  2. -------------------------------------------------------
  3.  
  4. WHAT IT IS
  5. ----------
  6.  
  7.      AGLREP is designed for those who sponsor GT Echomail conferences or
  8. carry GT Echomail conferences for others to pick up.  This program replaces
  9. the conference list created by the MDIST program when a user sends a  .GL  to
  10. to the system.
  11.  
  12.      Why?  Because.  The current GL list, while handy, could tell more than
  13. it does.  In this program I have attempted to add what I've always thought
  14. was missing from the current report.  I'll explain the details in a minute.
  15.  
  16. HOW TO USE IT
  17. -------------
  18.  
  19.      Simply place AGLREP directly after your nightly run of MDIST.  If you
  20. support Crash!Mail, you should probably put it in after the MDIST in there
  21. as well.  (Presuming you have one.)  Or, you could run it directly before
  22. you bag the mail for the evening.  It just doesn't matter; so long as it is
  23. run once after the mail in distributed and before it is bagged up again.
  24.  
  25.      Normally, AGLREP should be run without any command line parameters.
  26. However, if you call your routing file anything other than ROUTING.BBS,
  27. then you should include the name of your routing file as the command line
  28. parameter.  That is, if your routing file is named ROUTING.BBS, to run
  29. AGLREP you simply enter  AGLREP  and that is it.  If, however, your routing
  30. file is named something like  PANIC.NOT,  you would then enter
  31.   AGLREP PANIC.NOT  to use the program.  The rest it figures out on it's
  32. own.
  33.  
  34.      The program will hunt down all .GL lists that are outgoing from the
  35. local system.  If you run the program for the first time and have several
  36. old .GL reports floating around in the netmail area still, this may take
  37. some time.  Don't Panic - it only does each message once, so the next time
  38. it runs it will only do what is new.
  39.  
  40. DETAILS
  41. -------
  42.  
  43.      When it does find an outgoing .GL report, the first thing it does is
  44. change the subject of the message from  ECHOMAIL REPORT to  [Advanced]
  45. ECHOMAIL REPORT.  Next, it changes the  To:  field of the message from
  46. "Sysop" to the full name of the Sysop of the receiving node.  That is,
  47. "Sysop" is changed to a real name.
  48.  
  49.      Next, the report itself is rewritten.
  50.  
  51.      The report is divided into five columns.  Namely "Echo", "G-Bag",
  52. "Date", "Days", "Rating", and "Description".  The first column ("Echo") is
  53. of course the familar echo number.  (eg: E99/042.)  The second column
  54. ("G-Bag") simply contains a "Yes" if that particular echo is being sent to
  55. the message receiver.  If not, this is left blank.  The third column
  56. ("Date") is the echomail date that the echo was last sent out.  Again, this
  57. is only if the echo is in a G-Bag, otherwise the field will be blank.  So
  58. far, this is essentially the same information that is supplied with the
  59. current .GL MDIST report.  The next column, "Days", refers to the number of
  60. days old that echo is.  For example, if the last date the echo was sent was
  61. 1395, and the current echomail date is 1400, then there would be a "5" in
  62. the "Days" column.  (1400-1395=5)  Once more, this is only if the echo is
  63. being bagged in a G-Bag for the user.  Next is the "Rating" or "Status"
  64. column, which gives an English adjective describing the echo based on the
  65. value in "Days".  The rating ranges from "PERFECT" for echoes with no
  66. difference between the last echo date received and the current echo mail
  67. date, ("Days" = 0, or same-day-service!) and "*STALE*" for echoes not
  68. received in three weeks.  The last column, "Description", is the full echo
  69. description as listed in your ROUTING file - not cut off at 20 characters.
  70. (It will, however, be cut off at the end of the screen, around 49
  71. characters.)  Case will also remain the same as in the ROUTING file.
  72.  
  73.      Please note a couple of differences between the way this program
  74. creates the list and the way MDIST does.
  75.  
  76.      MDIST will only list echoes up through the E10 series.  This program
  77. will - normally - list up all the way to (but *NOT* including) the E99
  78. series.  This will make the report a little more accurate of what is
  79. carried on the system that might be available but above E10.  Notice that I
  80. say _NORMALLY_ it will only list up to E98.  *IF* a caller is set up to
  81. receive an E99 series echo, THEN that echo will be listed in the report.
  82. That is, the report will admit to having E99 echoes only if the caller is
  83. already receiving it - in which case the E99 will be treated as would any
  84. other echo series.
  85.  
  86.      Like MDIST, the AGL report will not list echoes whose descriptions
  87. begin with a semi-colon to users who do not have an "F" flag by their node
  88. in the BAG CONSOLIDATION section of the ROUTING file.  Again, the exception
  89. to this is if the caller is already getting the echo in a G-Bag.  That is,
  90. if the user is receiving an echo whose description is preceeded by a
  91. semi-colon, yet does not have the "F" flag set in BAG CONSOLIDATION, the
  92. echo will still appear in the report.  If the user does NOT subscribe to
  93. such an echo, then it will not appear.  Of course, if the "F" flag *IS*
  94. set, then all echoes will be reported.
  95.  
  96.      AGL, however, does treat these 'private' echoes, as well as scrambled
  97. echoes differently than MDIST does.  If an echo is private (that is, has
  98. the semi-colon before the description,) AGL will place the word "{Pvt}"
  99. before the description instead of the semi-colon.  Only in the report,
  100. mind you, it does not change the ROUTING file itself.
  101.  
  102.      If an echo is scrambled, that is, it has a password in (...) behind
  103. the description, then the word "{Scr}" will preceed the description.  This
  104. saves subscribers from .GMing an echo that they won't be able to read.
  105.  
  106.      If an echo is both private and scrambled, the description will be
  107. preceeded by "{Pvt/Scr}".
  108.  
  109.      At the end of the main echo list, the program tallies up the number of
  110. echoes listed (which may or may not be the number of echoes actually on the
  111. host system, depending on the number of private and E99 series echoes
  112. carried,) along with the current echomail date, and the age in days of the
  113. average echomail bag.  The latter will only be displayed if any bags are
  114. actually being RECEIVED - not much point in calculating the average age of
  115. nothing.
  116.  
  117.      Next in the report comes the list of echo conferences being received.
  118. This section is pretty well the same as MDIST's, except that the name of
  119. the host system is displayed along with the NET/NODE number, and there is a
  120. space between the comma following the echo number and the echomail date.
  121. For example, "E99/042, 1400" in contrast to "E99/042,1400".  Just more
  122. astheticly pleasing I thought.  Once again, this section will only be
  123. displayed if the sender of the .GL is actually receiving any echoes.
  124.  
  125.      And finally, at the end of the report, is once sentence that let's the
  126. caller know if his NET/NODE is set up for BAG CONSOLIDATION or not.  The
  127. caller then knows if there is any point in sending out that list of .GMs or
  128. not.
  129.  
  130.      The message is then time/date stamped and that's the end of it.
  131.  
  132. SAMPLE OUTPUT
  133. -------------
  134.  
  135. *****************************************************************************
  136.  
  137. Fm: NetMail System
  138. To: Joe User  at 042/042
  139. Sb: 047/000 - AGL ECHOMAIL REPORT
  140.  
  141. An Echomail status report for Joe User, the Sysop of 042/042:
  142.  
  143. Conferences available on 047/000 - Nanchinchee:
  144. ===============================================
  145.  
  146. Echo     G-Bag  Day   Old   Rating   Description
  147. -------  -----  ----  ----  -------  ----------------------------------------
  148. E00/024                              Ham Radio
  149. E00/025    Yes  1346     3    OK     Sports - All Sporting Events
  150. E00/032                              Amateur Astronomy
  151. E00/067                              CB Radio Conference
  152. E00/071    Yes  1345     4    OK     Motorcycle Forum
  153. E01/007                              The Echolist
  154. E01/008                              The Nodelist
  155. E02/354                              HitchHikers Guide To The Galaxy
  156. E10/003    Yes  1348     1   GOOD    Multitasking
  157. E10/009                              Shareware Only!
  158. E10/016                              Trading Post-Buy/Sell/Trade
  159. E10/024    Yes  1342     7   SLOW    UFOs Are they Real or Hoax
  160. E10/033                              Music
  161. E10/038                              Books And Movies
  162. E10/057                              Psychology, Psychotherapy
  163. E10/073    Yes     0        UnRec'd  Doctor Who & British SciFi
  164. E10/074                              Internation Guppies Scoreboard
  165. E10/079                              UK-USA International Chat
  166. E10/080    Yes  1347     2    OK     Compiled Basic Programming
  167. E42/241                              {Pvt} Bill's Private Echo
  168. E42/242                              {Scr} Bob's Scrambled Echo
  169. E42/243                              {Pvt/Scr} A Really Private Scramble One
  170. E99/002    Yes  1349     0  PEFECT   Local MH Music Echo
  171. -------  -----  ----  -------------------------------------------------------
  172.   23       7    1349    17   (Average is 2 days.)
  173.  
  174.  
  175. Conferences coming to you in a G-Bag from 047/000 - Nanchinchee:
  176. ================================================================
  177.  
  178. E00/025, 1346  E00/071, 1345  E10/003, 1348  E10/024, 1342  E10/073, 0000  
  179. E10/080, 1347  E99/002, 1349
  180.  
  181.     -You *ARE* set up for Bag Consolidation.
  182.  
  183. [Report created on 09-11-1990 at 19:10:31 by AGLREP V1.00.]
  184.  
  185. *****************************************************************************
  186.  
  187.  
  188. A BIT ON THE TECHNICAL SIDE
  189. ---------------------------
  190.  
  191.      -The AGL report will work with up to 300 echoes in the MESSAGE
  192.       DISTRIBUTION file.  This should be more than enough for quite some
  193.       time to come.
  194.  
  195.      -The echoes ARE sorted before being processed, although I must admit
  196.       that I did not use the most efficient or fastest sorting routing that
  197.       has been written.  The time it takes to sort the echoes will depend
  198.       on your machine, the number of echoes you carry, and how out of order
  199.       they were in.  On my 386SX, 300 randomly placed echoes took about 12
  200.       seconds to be sorted.  If they were already in order, this was cut
  201.       down to a tad over two seconds.  (And if you have 300 echoes and
  202.       store them in a random order, you are better at finding things than I
  203.       am.  And nuts too.)  A 100 entry pre-sorted file took less than one
  204.       second on my machine.
  205.  
  206.      -The AGL report changes it's subject field to reflect the style in the
  207.       new version of the Netmail software.  As well, the program will work
  208.       with both the old and the new versions of the Netmail software.
  209.  
  210.      -Any one node can receive up to 300 echoes (the maximum providec by
  211.       MDIST anyway,) and there can be up to 600 entries in the GCONSOL.CTL
  212.       file.  Hopefully this will be enough!
  213.  
  214.      -The program does use a lot of memory in order to improve it's speed
  215.       performance.  It will probably need at least 128K to operate.
  216.  
  217. OPERATING WITH DIFFERENT VERSIONS OF GT
  218. ---------------------------------------
  219.  
  220.     Currently, the program makes use of existing information to figure out
  221. what version of the GT software is running.  This is done by checking out
  222. your MMR configuration file to see what it says.  For those that don't use
  223. MMR (I've heard nasty rumours to that effect, but tend not to believe
  224. them,) this will cause you some trouble.  For you, and command line entry
  225. is in the works.  Keep watching.
  226.  
  227. A point about MMR: Register it.  Harry Green put an awful lot of work into
  228. a fine program and deserves your support.
  229.  
  230. REGISTRATION
  231. ------------
  232.  
  233.      I ask for no money for this program.  Once again, however, I do
  234. request that, if you use it and like it, drop me a postcard in the mail.  I
  235. like postcards.  They're fun.  They're exciting.  They're better than phone
  236. bills.
  237.  
  238.      Of course, should you WANT to include a few bucks, I wouldn't refuse
  239. it either!
  240.  
  241.                 Lloyd Ford
  242.                 c/o 262 Mitchell Cres. NW
  243.                 MEDICINE HAT, Alberta
  244.                 CANADA    T1A 6V4
  245.  
  246. EOF
  247.